Skip to content

Conversation

@m9tdev
Copy link

@m9tdev m9tdev commented Nov 13, 2025

Added an example on how to add serialization adapters for React Start. Not 100% sure if the right place is in the server function docs. LMK otherwise!

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide on custom serialization adapters with detailed configuration instructions and practical examples for handling complex data types.

@github-actions github-actions bot added the documentation Everything documentation related label Nov 13, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 13, 2025

Walkthrough

Adds a new "Custom serialization adapters" section to the Server Functions guide explaining how to implement and configure custom adapters (with a TypeScript bigint example); the same content is inserted in two places in the document. No API changes.

Changes

Cohort / File(s) Summary
Server Functions documentation
docs/start/framework/react/guide/server-functions.md
Inserted a "Custom serialization adapters" section (TypeScript example showing bigint adapter and integration with start configuration); content duplicated in two locations within the same file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Check whether the duplicated section is intentional or should be consolidated.

Poem

🐰 I nibble bytes and hop through code,

I teach bigints to find their road,
Two chapters sing the adapter song,
Small changes, tidy, short and strong.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs(react-start): serialization adapters' clearly and concisely summarizes the main change: adding documentation about serialization adapters for React Start.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 86875e6 and e1ba504.

📒 Files selected for processing (1)
  • docs/start/framework/react/guide/server-functions.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/start/framework/react/guide/server-functions.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@birkskyum
Copy link
Member

@m9tdev can you add the same to the solid docs so they stay in sync?

@schiller-manuel
Copy link
Contributor

we need to document serialization adapters more generally, not just for server functions. they apply for beforeLoad and loader as well. a separate doc page should be added for this. want to do this when i find the time :)

@m9tdev
Copy link
Author

m9tdev commented Nov 18, 2025

@birkskyum Should they be the same for Solid? I have no experience with Solid, but if they are the same I'll add them!

@schiller-manuel Maybe we can add this in the meantime to save others some time when looking for it.

@nx-cloud
Copy link

nx-cloud bot commented Nov 18, 2025

View your CI Pipeline Execution ↗ for commit 86875e6

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded <1s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-18 10:43:12 UTC

@birkskyum
Copy link
Member

birkskyum commented Nov 18, 2025

Yes it's the same for solid, except for the package name being solid-start

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related missing-solid-version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants